home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / qwkrk60.zip / QWKRICK.DOC < prev    next >
Text File  |  1993-03-09  |  13KB  |  350 lines
  1.                           QWKRick Version .70 Beta
  2.  
  3.                                March 8, 1993
  4.  
  5.                 Created with Searchlight Programmer's Library
  6.                Portions Copyright (c) 1992 Searchlight Software
  7.  
  8.  
  9.         Welcome to the wonderful world of QWK Mail Doors.  This program,
  10. named 'QWKRick' will allow your users to Scan and Download new Messages
  11. and Mail from SearchLight Version 3.00 and Higher.
  12.  
  13.         Many hours were spent working on this door and it is not FreeWare!
  14. It has been released as Shareware and as such, the Author expects compensation
  15. for his hard work and time.  As this is a Beta Version, a price has not yet
  16. been set, but expect it to be in the $10-20 range.  The Author also makes no
  17. warranties, implied or expressed, to the correct funtioning of this door.
  18.  
  19.  
  20. Installation
  21. ────────────
  22.  
  23.         All QWKRick needs to know is what it is expected to do.
  24.  
  25.         An Example of the Download menu is as follows:
  26.  
  27.  1. Command Name .................. Download
  28.  2. Command Key ................... D
  29.  3. Description ................... Download a Mail Packet
  30.  4. Minimum Access Level ..........      0
  31.  5. Maximum Access Level ..........    255
  32.  6. Required Attributes ...........
  33.  7. Exclude Attributes ............
  34.  8. Preference Attributes .........
  35.  9. Help Levels ................... All
  36. 10. Door Command .................. QWKRick.exe DOWN
  37. 11. Directory Path ................ C:\BBS\RICK
  38. 12. Communications Support ........ Standard
  39. 13. Abort Method .................. Terminate
  40. 14. Write Protection .............. No
  41. 15. Parameter File ................ None
  42. 16. Pause After Door .............. No
  43.  
  44.         Line 10 contains the command to Download new Messages from the BBS,
  45. the only important letter is D, although you may specify all or part of
  46. Download if you want.  If running from a batch file then Line 10 would contain
  47. the name of the Batch file and Line 11 the directory in which you've stored
  48. the batch file.   The batch would then look something like this:
  49.  
  50.                         c:
  51.                         cd \bbs\rick
  52.                         Set SLBBS=c:\bbs\node1
  53.                         QWKRick.exe Down
  54.  
  55.  
  56.         An Example of the Upload menu is as follows:
  57.  
  58.  1. Command Name .................. Upload
  59.  2. Command Key ................... U
  60.  3. Description ................... Upload a Mail Packet
  61.  4. Minimum Access Level ..........      0
  62.  5. Maximum Access Level ..........    255
  63.  6. Required Attributes ...........
  64.  7. Exclude Attributes ............
  65.  8. Preference Attributes .........
  66.  9. Help Levels ................... All
  67. 10. Door Command .................. QWKRick.exe UP
  68. 11. Directory Path ................ C:\BBS\RICK
  69. 12. Communications Support ........ Standard
  70. 13. Abort Method .................. Terminate
  71. 14. Write Protection .............. No
  72. 15. Parameter File ................ None
  73. 16. Pause After Door .............. No
  74.  
  75.         Line 10 contains the command to Upload new Messages to the BBS,
  76. the only important letter is U, although you may specify all or part of
  77. Upload if you want.  If running from a batch file then Line 10 would contain
  78. the name of the Batch file and Line 11 the directory in which you've stored
  79. the batch file.   The batch would then look something like this:
  80.  
  81.                         c:
  82.                         cd \bbs\rick
  83.                         Set SLBBS=c:\bbs\node1
  84.                         QWKRick.exe Up
  85.  
  86.         Remember that in order to run, the SLBBS environment variable must
  87. be set to your BBS path.  An example is:
  88.  
  89.                 Set SLBBS=c:\bbs\node1
  90.  
  91.         The above menus are included to make it a little easier to install.
  92. Frank LaRosa has also included a new command in SL 3.00 or greater. Command
  93. number 144.  This command will allow the users to edit their QWK Options.
  94.  
  95.         The layout of the menu is as follows:
  96.  
  97. Options:
  98.  1. Transfer Protocol ............. Zmodem
  99.  2. Archive Type .................. ZIP
  100.  3. Packet Number .................     32
  101.  4. Naming Convention ............. Prefix
  102.  5. Generate Indexes .............. Yes
  103.  6. DL Messages from You .......... Yes
  104.  7. Mark New Messages ............. Yes
  105.  8. Packet Type ................... QWK
  106.  
  107. Line 1 -        Xfer Protocol.  Xmodem, Ymodem and Zmodem are supported.
  108.  
  109. Line 2 -        Archiver.  Currently only ZIP is supported, but others will
  110.                 be added soon.
  111.  
  112. Line 3 -        Packet Number.  The number that will be appended to the name
  113.                 of the download packet.  (IE BBSID32.QWK)
  114.  
  115. Line 4 -        The method in which the Download packet is called.
  116.                 Prefix will generate BBSID##.QWK packets.
  117.                 Suffix will generate BBSID.QW# packets.
  118.  
  119.                 Some off-line readers, notably BlueWave, prefer the BBSID.QW#
  120.                 format.
  121.  
  122. Line 5 -        Generate .NDX files per conference.  Again, some readers do
  123.                 not need .NDX files to funtion, thereby saving download time.
  124.  
  125. Line 6 -        Download messages that you entered or Uploaded, if No, then
  126.                 any messages with the same user name as the current user will
  127.                 not be selected for download
  128.  
  129. Line 7 -        Mark New Messages will update High Message Pointers if set to
  130.                 YES, other wise it will leave them alone.
  131.  
  132. Line 8 -        User configurable New Files scan.  Until the Options are
  133.                 changed, QWK stands for Yes and Text Stands for No.
  134.  
  135.  
  136.  
  137. Local Use
  138. ─────────
  139.  
  140.         QWKRick may be used locally, just insure that the BBSID.rep packet
  141. is in the same directory as QWKRick.  QWKRick will move and unzip it itself,
  142. and delete it when done.  Downloads will be placed in the same spot.
  143.  
  144.  
  145. Other Neat Stuff
  146. ────────────────
  147.  
  148.         Users may add or drop conferences remotely by sending a message to
  149. QWKRick, SEARCHLIGHT or '' (IE no To User) in the conference they wish to
  150. add or drop.  The Subject line should then contain the word ADD or DROP.
  151. QWKRick will then ADD or DROP the user from the Message Base in which the
  152. message was uploaded to.
  153.  
  154.         Many offline reader support this directly so the user doesn't have to
  155. worry about it if they Add or Drop the conference via their reader.
  156.  
  157.  
  158.  The QWKRICK File
  159.  ──────────────────
  160.  
  161.         An QWKRICK.CFG file must exist in the same directory as QWKRick in
  162. order for QWKRick to operate.  A sample file is included, but the layout is
  163. as follows.
  164.  
  165. St. Laurent, Quebec
  166. (514) 748-5673
  167. Rick Macdougall,Sysop
  168. 985,RIGEL
  169. RIGEL
  170. 300 Baud,25,50
  171. 600 Baud,50,100
  172. 1200 Baud,100,200
  173. 2400 Baud,200,400
  174. 4800 Baud,400,800
  175. 7200 Baud,500,1000
  176. 9600 Baud,500,1000
  177. 12000 Baud,500,1000
  178. 14400 Baud,500,1000
  179. 16800 Baud,600,1600
  180. 19200 Baud,600,1600
  181. 38400 Baud,600,1600
  182. Local,1000,5000
  183. Yes ; Error Log
  184. Yes ; User Log
  185. Yes ; Enforce Time Checking
  186. pkzip %F
  187. pkunzip %F
  188. c:\bbs\node1\gsz.exe portx %A,%I sx %F
  189. c:\bbs\node1\gsz.exe portx %A,%I sb -k %F
  190. c:\bbs\node1\gsz.exe portx %A,%I sz %F
  191. c:\bbs\node1\gsz.exe portx %A,%I rx %F
  192. c:\bbs\node1\gsz.exe portx %A,%I rb -k %F
  193. c:\bbs\node1\gsz.exe portx %A,%I rz %F
  194. AAAAAAA
  195.  
  196. ------------------------------------------------------------------
  197.                         !!! Warning !!!
  198.  
  199.    Changes made above the line affect the running of your SL QWK Door!
  200.         Please Read the Following lines before making any changes.
  201.  
  202. Line 1: Your Location.  Free Format Field, you may change it as you like.
  203.  
  204. Line 2: Your BBS Phone Number.  Format should stay as (XXX) XXX-XXX, but it
  205.         really shouldn't hurt the working of the Door if it is modified.
  206.  
  207. Line 3: Sysops Real Name and alias on the board.  Again Free Format, but try
  208.         to keep it similar.
  209.  
  210. Line 4: Your SL Registration Number and BBSID.  This line is Important!  Do
  211.         Not add a space after the Comma!  And some Readers prefer if it is
  212.         capitalized.
  213.  
  214. Line 5: Your BBSID again.  No Spaces, Capitalized etc..  I know it's duped,
  215.         but this is just a temp fix until the Sysop Editor is finished.
  216.  
  217. Lines 6 thru 18:
  218.  
  219.         Baud Rate Lines in the format:
  220.  
  221.                 Comment,Max Messages per sub, Max Messages Total
  222.  
  223.         Do not remove any of the lines, but you may change the values to
  224.         whatever you like.  The first part (Comment) is just that, a Comment,
  225.         so you may but whatever you like there, but I highly recommend you
  226.         leave them as is so that you remember what baud rate each line is.
  227.  
  228. Line 19: Error Log Creation.  First character only is checked.  Yes is on,
  229.          No is off.
  230.  
  231. Line 20: User Log Creation. First Character only is Checked.  Yes is on,
  232.          No, is off.
  233.  
  234. Line 21: Enforce Time Checking.  First Character Only.  If set to Yes, then
  235.          QWKRick will check to make sure that enough time remains for the
  236.          user to download the packet.  If set to No then no time limit
  237.          checking is done.
  238.  
  239. Line 22: Archive Command Line. %F is replaced by the filename and files to
  240.          Archive in the format 'Pkzip.exe BBSID.QW# *.*'
  241.                                           ^^^^^^^^^^^^^
  242.  
  243. Line 23: DeArchive Command Line.  %F is replaced by the filename to De-
  244.          archive in the format 'Pkunzip.exe BBSID.REP'
  245.                                             ^^^^^^^^^
  246.  
  247. Line 24: Xmodem or THIRD protocol SEND option.  Command line parameters
  248.          will be explained at the end of this section.
  249.  
  250. Line 25: Ymodem or SECOND protocol SEND option.  Command line parameters
  251.          will be explained at the end of this section.
  252.  
  253. Line 26: Zmodem or FIRST protocol SEND option.  Command line parameters
  254.          will be explained at the end of this section.
  255.  
  256. Line 27: Xmodem or THIRD protocol RCV option.  Command line parameters
  257.          will be explained at the end of this section.
  258.  
  259. Line 28: Ymodem or SECOND protocol RCV option.  Command line parameters
  260.          will be explained at the end of this section.
  261.  
  262. Line 29: Zmodem or FIRST protocol RCV option.  Command line parameters
  263.          will be explained at the end of this section.
  264.  
  265. Line 30: Registration Code linked to your BBS Reg number on line 4!
  266.  
  267.         All other following Lines are optional, but it's a good idea to keep
  268.         them around just in case!
  269.  
  270.  
  271. Command Line Parameters for Protocol Lines
  272. ──────────────────────────────────────────
  273.  
  274.         All command line parameters must specify all full pathname and file
  275.         name (unless you but them in the same directory as QWKRick).
  276.  
  277.  %A     Replaced by address of the com port in the format 2E8.
  278.  
  279.  %B     Replaced with the Locked Baud Rate of the board.
  280.  
  281.  %C     Replaced with the Config Path Variable.  IE c:\bbs\node1\
  282.  
  283.  %E     Replaced with the Actual or Effective Baud Rate of the user
  284.  
  285.  %I     Replaced with the IRQ number of the current com port
  286.  
  287.  %P     Replaced with the current com port Number. IE 2 NOT com 2
  288.  
  289.  %F     Replaced with the BBSID File Name to download or upload.
  290.         Downloads will have the format BBSID#.QWK or BBSID.QW# and
  291.         Uploads will have the format BBSID.REP.
  292.  
  293.  
  294. Using SL's replacement Zmodem
  295. ─────────────────────────────
  296.  
  297.         Similar to GSZ or DSZ, but make sure to include the -C command line
  298.         option to insure that it doesn't toggle the comm support.
  299.  
  300.  
  301. Upcoming Enhancements
  302. ─────────────────────
  303.  
  304.         Import and Export of QWK network packets. (Maybe another project
  305.                                                    entirely!)
  306.         Support for New Bulletin files.
  307.         Support for Hello and Goodbye Screen files.
  308.         Support for File Requesting via QWKRick.
  309.         Anything else that comes out of this beta test.
  310.  
  311.  
  312. Kudo's and Accolades
  313. ────────────────────
  314.  
  315.         My thanks to Frank LaRosa and Tim Rossiter of Searchlight Software,
  316. Jack Ridgeway of ABS Software and all my great Beta Testers.
  317.  
  318.         Portions of QWKRick were written with SearchLight Programmers Library.
  319.  
  320.  
  321. Problems or Questions
  322. ─────────────────────
  323.  
  324.         Please contact me if you have any questions, problems or suggestions.
  325.  
  326.         I can be reached at the following locations:
  327.  
  328. Rick Macdougall (Me)
  329.  
  330. 250:10/0        SL Net
  331. 1:167/135       Fido Net
  332. (514) 748-5673  Rigel BBS
  333. (514) 747-9405  Voice Phone Nights and weekends. Please Feel free to call
  334.                 if any problems crop up.
  335.  
  336. Chris Ross (Alpha Site)
  337.  
  338. 250:1000/1352   SL Net
  339. (514) 466-9637  Evening Shade BBS 
  340.  
  341.  
  342.         This is a beta test version, and as such, I ask that you do not
  343. distribute it.  This also explains the lack of real documentation... <g>
  344.  
  345.  
  346. Rick Macdougall
  347. March 8th, 1993
  348.  
  349. Copywrite 1993 JRM Enterprises
  350.